home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / prgtools / mint / mntdoc01.zoo / mintdoc / read.me < prev    next >
Encoding:
Text File  |  1993-03-03  |  2.6 KB  |  54 lines
  1. Hi all,
  2.  
  3. This is MNTDOC01, the MiNT documentation package version 0.1.
  4. The MiNT documentation package is meant as a complete documentation
  5. package for all programmers using MiNT and the mintlibs. It contains the
  6. 'official' MiNT documentation as supplied by Eric Smith, the MiNT system
  7. call documentation as written by Eric Smith, and documentation for part
  8. of the mintlibs.
  9.  
  10. This documentation has grown from a Pure-C user-defined helpfile, and
  11. still is based on that. Since many people do not have Pure-C or do want
  12. to use the documentation on-line in a terminal or toswin window, the
  13. documentation is also supplied in nroff -man format (both raw and
  14. formatted). Since the nroff -man version is translated from the Pure-C
  15. helpfile by a simple computer program, it doesn't look all that nice.
  16. Too bad, it will get better in the next version.
  17.  
  18. The mintdocs are up-to-date for MiNT 0.95 (official docs), MiNT 0.99
  19. (system call docs) and the mintlibs pl 30 (mintlib docs).
  20.  
  21. Installation and use:
  22. - copy USR.HLP to your Pure-C directory (Pure-C only)
  23. - merge the Pure-C sources with your own if you already have your own
  24.   user-defined helpfile that you like to keep. (Pure-C only)
  25. - copy the contents of the man2, man3, cat2, cat3 directories to your
  26.   /usr/man directory to use the docs with 'man'. ('man' users only)
  27. - study the contents of the c_src directory and see if you can use it.
  28. - just read the docs in the mintdocs directory (install in brain)
  29.  
  30. Copyrights:
  31. MiNT is copyrighted by Eric Smith and Atari Corp. So are the MiNT docs
  32. supplied here and the MiNT system call documentation. The mintlib docs
  33. are free; however, if you make them into something else, I'd like it if
  34. you left my name in it. The contents of the c_src/* directory is
  35. freeware; again, please leave my name in this stuff.
  36.  
  37. Future:
  38. In the near future, more mintlib documentation will be added as my spare
  39. time permits. First, I want to finish the <unistd.h>, <stdio.h>,
  40. <stdlib.h> and <support.h> calls; later, I may add other stuff. If you
  41. really need something or want to add some stuff you did yourself, mail
  42. me.
  43. Also in the near future, I will improve the layout of the nroff man
  44. pages (i.e., add bold/italic stuff where needed). If there is a demand
  45. for it, I will also supply a 'book' of documentation in dvi or
  46. PostScript format (mail me if you want that!).
  47. In the medium to long term future, I'll be working on a hypertext system
  48. and document conversion utilities. Some of that work may be reflected in
  49. these docs. No promises, however!
  50.  
  51. Bye,
  52.   Hildo Biersma
  53.   boender@dutiws.twi.tudelft.nl // schuller@dutiag.twi.tudelft.nl
  54.